dxp-ux

1.0.x
(0 reviews)

TMF683 - Party Interaction

1. GET /partyInteraction

This operation list or find PartyInteraction entities.

URL
https://[host]:[port]/dxp-ux/v1/{businessId}/partyInteraction
URL PARAMS
nametypedescriptionrequired
businessIdstring2 letter ISO 3166 country code (PA etc.) identifying the business unit.Y
namevaluedescriptionrequired
client_idstringThe client_id identifying the channel. Minimum characters: 5Y
client_secretstringPassword associated with the client_id. Minimum characters: 5Y
X-Correlation-IDstringIdentifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.Y
Query Params
nametypedescriptionrequired (mandatory-Y, optional-N, Not applicable- N/A)
interactionItem.item.idstringunique identifier of the account.Y(PA)
interactionItem.item.@typestringDefines the type of interactionItem.item.idY(PA)
Data Model
Response Data Model
nametypedescriptionrequired (mandatory-Y, optional-N, Not applicable- N/A)
idstringUnique identifier of the service / MSISDN / serviceNumberY(PA,CWC)
hrefstringreference link of the serviceY(PA,CWC)
serviceTypestringBusiness type of the serviceY(PA,CWC)
serviceDatestringDate when the service was createdY(PA,CWC)
startDatestring($date-time)Date when the service startsN/A(PA), N(CWC)
endDatestring($date-time)Date when the service endsN/A(PA), N(CWC)
categorystringIs it a customer facing or resource facing serviceY(PA,CWC)
isServiceEnabledbooleanIf FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service as failed.Y(PA,CWC)
namestringName of the serviceN/A(PA), N(CWC)
statestringstate of the serviceY(PA,CWC)
hasStartedbooleanIf TRUE, this Service has already been startedY(PA,CWC)
serviceSpecificationobjectA service specification reference. The specification from which this service was instantiated.Y(PA,CWC)
serviceSpecification.idstringunique identifierY(PA,CWC)
serviceSpecification.@typestringWhen sub-classing, this defines the sub-class Extensible nameY(PA,CWC)
serviceSpecification.namestringName of the related entity.Y(PA,CWC)
feature[]Object ArrayA list of feature associated with this service.Y(PA,CWC)
feature[].namestringThis is the name for the featureY(PA,CWC)
feature[].isEnabledbooleanTrue if this feature is enabled. Default is trueY(PA,CWC)
feature[].featureCharacteristic[].namearrayA feature associated with the prepaidfiberY(PA), N(CWC)
feature[].featureCharacteristic[].value.remainingDaysobject ArrayValue of the remaining days of prepaid fiber serviceY(PA), N(CWC)
feature[].featureCharacteristic[].value.startDateobject Arrayvalue of the start date of prepaid fiber serviceY(PA), N(CWC)
feature[].featureCharacteristic[].value.expiryDateobject Arrayvalue of the expiry date of prepaid fiber serviceY(PA), N(CWC)
feature[].featureCharacteristic[].value.totalDurationobject Arrayvalue of the total duration of prepaid fiber serviceY(PA), N(CWC)
feature[].featureCharacteristic[].valueTypeobject Arrayvalue TypeY(PA), N(CWC)
supportingService[]Object ArrayA collection of services that support this serviceY(PA,CWC)
supportingService[].idstringUnique identifier of the serviceY(PA,CWC)
supportingService[].namestringA list of supporting servicesY(PA,CWC)
supportingService[].feature[]Object ArrayA list of feature associated with this service.Y(PA),N(CWC)
supportingService[].feature[].namestringThis is the name for the featureY(PA),N(CWC)
supportingService[].feature[].isEnabledbooleanTrue if this feature is enabled. Default is trueY(PA),N(CWC)
supportingService[].serviceSpecification.idstringunique identifierN/A(PA), Y(CWC)
supportingService[].serviceSpecification.namestringName of the related entity.N/A(PA), Y(CWC)
serviceCharacteristic[]Object ArrayA list of characteristics that characterize this serviceY(PA,CWC)
serviceCharacteristic[].namestringName of the characteristicY(PA,CWC)
serviceCharacteristic[].idstringidentifier of the characteristicY(PA,CWC)
serviceCharacteristic[].valueobjectValue of the characteristicY(PA,CWC)
serviceCharacteristic[].value.productStatusCodestringstatus code of the productY(PA,CWC)
serviceCharacteristic[].value.uniqueProductIdstringunique identifier of the productY(PA,CWC)
serviceCharacteristic[].value.productActivebooleanactive state of productY(PA,CWC)
serviceCharacteristic[].value.pricenumberprice of the productY(PA),N(CWC)
serviceCharacteristic[].value.modelNumberstringmodelNumber value for the service characteristicY(PA),N(CWC)
serviceCharacteristic[].value.macAddressstringmacAddress value for the service characteristicN/A(PA),N(CWC)
serviceCharacteristic[].value.voiceMacAddressstringvoiceMacAddress value for the service characteristicN/A(PA),N(CWC)
serviceCharacteristic[].value.deviceStatusCodestringdeviceStatusCode value for the service characteristicN/A(PA),N(CWC)
serviceCharacteristic[].value.serialNumberstringserialNumber value for the service characteristicN/A(PA), N(CWC)
serviceCharacteristic[].value.isPrimarybooleanindicates if the product is primaryY(PA),N(CWC)
serviceCharacteristic[].value.@typestringtype of the valueY(PA),N(CWC)
serviceCharacteristic[].value.productTypestringtype of the productN/A(PA),N(CWC)
serviceCharacteristic[].value.installationChargestringtype of the product chargeY(PA),N(CWC)
relatedParty[]Object ArrayA related party defines party or party role linked to a specific entityY(PA,CWC)
relatedParty[].idstringunique identifierY(PA,CWC)
relatedParty[].rolestringrole of the partyY(PA,CWC)
serviceOrderItem[]Object ArrayA list of service order items related to this serviceY(PA,CWC)
serviceOrderItem[].itemIdstringIdentifier of the order item where the service was managedY(PA,CWC)
serviceOrderItem[].serviceOrderIdstringUnique identifier of a related entity.Y(PA,CWC)
place[]Object ArrayA list of placesY(PA,CWC)
place[].idstringUnique identifier of the place.Y(PA,CWC)
place[].rolestringrole of the addressY(PA,CWC)
place[].streetNamestringname of the streetY(PA,CWC)
place[].districtstringdistrict of the placeY(PA,CWC)
place[].provincestringprovince code.Y(PA,CWC)
relatedEntity[]Object ArrayRelated Entity reference.N/A(PA),Y(CWC)
relatedEntity[].idstringunique identifierN/A(PA),Y(CWC)
relatedEntity[].rolestringRole played by the related entityN/A(PA),Y(CWC)
relatedEntity[].@typestringWhen sub-classing, this defines the sub-class Extensible name.N/A(PA),Y(CWC)
@typestringWhen sub-classing, this defines the sub-class Extensible name.Y(PA,CWC)
feature subResource - dataModel
Key considerations
Key Considerations for PA:
  • The GET /partyInteraction API is used to retrieve the Percentage Discount information based on the Pricing Plan and Fixed Dollar Discount applied to the customer's account.
  • creationDate: Indicates the date when the discount was applied to the customer's account.
  • description: Provides details about the account-level discount that was granted.
  • reason: Displays a short name or code representing the discount type.
  • interactionItem[].item: Identifies the billing account to which the discount applies.
  • interactionItem[].note[].text: Shows the pricing plan name and the fixed discount amount applied to the customer's account.

Reviews